Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Change from % to ! in the first cell to run properly in Colab. #496

Merged

Conversation

giovaniceotto
Copy link
Member

Pull request type

  • ReadMe, Docs and GitHub updates

Checklist

  • Docs have been reviewed and added / updated

Current behavior

The first code cell of our Google Colab Getting Started Notebook fails because it is using % instead of ! to execute shell commands.

New behavior

  1. In the first code cell, % was replaced by ! and netCDF was removed from pip install since it is already installed when RocketPy is installed now.
  2. ``%load_ext autoreload` was removed since it is not relevant for the Getting Started notebook.
  3. Text cells were adjusted accordingly.

Breaking change

  • No

Additional information

This does not affect the RocketPy package in PyPI, so a new release is not necessary. As it affects only an example referenced in the ReadMe, I suggest merging it directly to master soon.

You can run the new fixed notebook here: https://colab.research.google.com/github/RocketPy-Team/rocketpy/blob/doc/fix-getting-started-colab-notebook-error/docs/notebooks/getting_started_colab.ipynb

@Gui-FernandesBR
Copy link
Member

Could we no longer use a git clone command in this notebook?

We are currently downloading more than 1.7 GB of data just to use a drag curve and a thrust curve. It's completely unnecessary.

I would suggest we should download only the two files we need. This would speed up our getting started example by a lot.

@Gui-FernandesBR
Copy link
Member

The following notebooks also suffer from the same problem:

  • dispersion_analysis.ipynb
  • parachute_drop_from_helicopter.ipynb
  • deployable_payload_example.ipynb

Should we also update them?

@MateusStano MateusStano changed the base branch from master to rel/v1.1.4 December 7, 2023 00:11
@MateusStano MateusStano merged commit 7a06868 into rel/v1.1.4 Dec 7, 2023
4 checks passed
@MateusStano MateusStano mentioned this pull request Dec 7, 2023
@Gui-FernandesBR Gui-FernandesBR deleted the doc/fix-getting-started-colab-notebook-error branch December 7, 2023 04:16
@Gui-FernandesBR
Copy link
Member

The % works for me on colab.

image

@Gui-FernandesBR Gui-FernandesBR added the Docs Docs and examples related label Feb 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Docs and examples related
Projects
Status: Closed
Development

Successfully merging this pull request may close these issues.

3 participants